home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Fritz: All Fritz
/
All Fritz.zip
/
All Fritz
/
FILES
/
PROGMISC
/
FXREF12.LZH
/
TLDR20.ZIP
/
TOOLDRIV.DOC
< prev
next >
Wrap
Text File
|
1992-12-21
|
80KB
|
1,791 lines
T o o l D r i v e r
Version 2.0
────────────────────
User's Guide
Organizing files and naming conventions /
Professional Tools /
for Software Developers and Consultants
┌───────┐
┌───────┐ │ (R)
──│ │ │───────────────────
│ ┌───────┐ │ Association of
ConVal Software, Inc. │ │ │─┘ Shareware
└──│ o │ Professionals
─────│ | │─────────────────────
└───┴───┘ MEMBER
T o o l D r i v e r
Version 2.0
────────────────────
User's Guide
Organizing files and naming conventions /
Professional Tools /
for Software Developers and Consultants
┌───────┐
┌───────┐ │ (R)
──│ │ │───────────────────
│ ┌───────┐ │ Association of
ConVal Software, Inc. │ │ │─┘ Shareware
└──│ o │ Professionals
─────│ | │─────────────────────
└───┴───┘ MEMBER
Copyright 1990-1992 ConVal Software, Inc.
All rights reserved.
This program is produced by a member of the Association of Shareware
Professionals (ASP). ASP wants to make sure that the shareware principle
works for you. If you are unable to resolve a shareware-related problem with
an ASP member by contacting the member directly, ASP may be able to help.
The ASP Ombudsman can help you resolve a dispute or problem with an ASP
member, but does not provide technical support for members' products.
Please write to the ASP Ombudsman at:
ASP Ombudsman
545 Grover Road
Muskegon, MI 49442-9427
U.S.A.
or send a CompuServe message via CompuServe MAIL to ASP Ombudsman
70007,3536.
The ombudsman may be contacted by FAX by sending to the ASP FAX number:
(616) 788-2765. In communication with the ombudsman please include a
telephone number and/or FAX if available.
Turbo Vision is a registered trademark of Borland International, Inc.
Portions Copyright Borland International, Inc. Used by permission.
TABLE OF CONTENTS
Preface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
SECTION 1: Introduction. . . . . . . . . . . . . . . . . . . . . . . . . 9
What's in ToolDriver?. . . . . . . . . . . . . . . . . . . . . . . . . . 9
Hardware and software requirements . . . . . . . . . . . . . . . . . . . 9
How to contact ConVal Software . . . . . . . . . . . . . . . . . . . . . 9
The ToolDriver package . . . . . . . . . . . . . . . . . . . . . . . . 10
SECTION 2: Installing ToolDriver . . . . . . . . . . . . . . . . . . . 10
SECTION 3: ToolDriver Basics . . . . . . . . . . . . . . . . . . . . . 11
Starting ToolDriver. . . . . . . . . . . . . . . . . . . . . . . . . . 11
Exiting ToolDriver . . . . . . . . . . . . . . . . . . . . . . . . . . 11
The User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . 11
The menu bar and menus. . . . . . . . . . . . . . . . . . . . . . . 12
Working with windows. . . . . . . . . . . . . . . . . . . . . . . . 14
The status line . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Dialog boxes. . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Action buttons. . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Radio Buttons and check boxes . . . . . . . . . . . . . . . . . . . 19
Input boxes and list boxes. . . . . . . . . . . . . . . . . . . . . 19
SECTION 4: Menus and options reference . . . . . . . . . . . . . . . . 20
≡ (System) menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Register. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Product Information . . . . . . . . . . . . . . . . . . . . . . . . 20
File menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Change Dir. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
DOS Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Quit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Edit menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Cut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Copy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Show Clipboard. . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Search menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Find. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Replace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Search Again. . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
FileXref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Files to cross reference. . . . . . . . . . . . . . . . . . . . . . 28
Words to cross reference. . . . . . . . . . . . . . . . . . . . . . 29
Start cross referencing . . . . . . . . . . . . . . . . . . . . . . 29
Condensed Reports. . . . . . . . . . . . . . . . . . . . . . . . 31
Extended Reports . . . . . . . . . . . . . . . . . . . . . . . . 32
Export files . . . . . . . . . . . . . . . . . . . . . . . . . . 33
View the output log . . . . . . . . . . . . . . . . . . . . . . . . 34
NameChanger menu . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Files to process. . . . . . . . . . . . . . . . . . . . . . . . . . 35
Names to be changed . . . . . . . . . . . . . . . . . . . . . . . . 36
Start name changing . . . . . . . . . . . . . . . . . . . . . . . . 36
View the output files . . . . . . . . . . . . . . . . . . . . . . . 37
Window menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Size/Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Zoom. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Tile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Cascade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Next. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Previous. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Help menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
INDEX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
FIGURES
Figure 1: A typical window . . . . . . . . . . . . . . . . . . . . . . . 15
Figure 2: View a File dialog box . . . . . . . . . . . . . . . . . . . . 21
Figure 3: Change Directory dialog box. . . . . . . . . . . . . . . . . . 23
Figure 4: The Find Text dialog box . . . . . . . . . . . . . . . . . . . 26
Figure 5: The Replace Text dialog box. . . . . . . . . . . . . . . . . . 27
Figure 6: Files to cross reference . . . . . . . . . . . . . . . . . . . 28
Figure 7: The Cross reference files dialog . . . . . . . . . . . . . . . 30
Figure 8: Condensed File Cross Reference Report. . . . . . . . . . . . . 31
Figure 9: Condensed Word Usage Report. . . . . . . . . . . . . . . . . . 31
Figure 10: List of Unreferenced Files. . . . . . . . . . . . . . . . . . 32
Figure 11: Extended File Cross Reference Report. . . . . . . . . . . . . 32
Figure 12: Extended Word Usage Report. . . . . . . . . . . . . . . . . . 33
Figure 13: Cross reference export data . . . . . . . . . . . . . . . . . 34
Figure 14: Unreferenced files export data. . . . . . . . . . . . . . . . 34
Figure 15: NameChanger Files dialog. . . . . . . . . . . . . . . . . . . 35
Figure 16: The Change names dialog . . . . . . . . . . . . . . . . . . . 36
Figure 17: View the name-changed files dialog box. . . . . . . . . . . . 37
TABLES
Table 1: General hot keys. . . . . . . . . . . . . . . . . . . . . . . . 13
Table 2: Menu hot keys . . . . . . . . . . . . . . . . . . . . . . . . . 13
Table 3: Editing hot keys. . . . . . . . . . . . . . . . . . . . . . . . 13
Table 4: Window management hot keys. . . . . . . . . . . . . . . . . . . 14
Table 5: Online help hot keys. . . . . . . . . . . . . . . . . . . . . . 14
Table 6: How to use windows. . . . . . . . . . . . . . . . . . . . . . . 17
Table 7: Export file flags . . . . . . . . . . . . . . . . . . . . . . . 33
Preface
──────────────────────────────────────
Welcome to this user guide to ToolDriver. It describes how you can
better organize your files and names. This information will be
useful to anyone responsible for developing, managing, or
maintaining application software.
You will learn:
■ The value of understanding the relationships of source files.
■ How planning your naming conventions can assist in debugging.
■ How to uncover obsolete components.
■ An easy way to change old programs to your current naming style.
■ Organizing tricks that eliminate entire classes of problems.
■ Characteristics of a well organized application.
■ Ways to prevent unanticipated naming problems.
Software applications require careful planning and thoughtful
implementation. The information provided here will help you
understand the detailed organization of your application and
communicate that understanding to others, making your job much
easier.
Page 9
SECTION 1: Introduction
──────────────────────────────────────
What's in ToolDriver?
■ An integrated environment for running the ConVal programming tools.
■ FileXref - cross references your files and names. It reads text files and
documents their use of other files and words you've selected. It works on
many languages including C, C++, Pascal, COBOL, BAS, MASM, SQL, Fortran,
and xBase. And it works on all documentation in text file form.
■ NameChanger - transforms names in the files associated with your
application.
■ FileList - reads your disk and creates a list of file names to be cross
referenced.
■ Cre8FSL - A tool like FileList. It creates a list of file names to be
name-changed.
Hardware and software requirements
ToolDriver runs on machines with an 80286 or higher processor and running
DOS 3.1 or higher. A hard disk, and at least one floppy drive are also
required to run ToolDriver.
ToolDriver supports (but does not require) any Windows-compatible mouse.
How to contact ConVal Software
ConVal Software, Inc.
11607 E. Butter Creek Road
Moorpark, CA 93021-2412
Sales and
technical support: Monday - Friday
Voice (805) 529-6847 9 AM - 5 PM Pacific Time
Fax (805) 529-4314
CompuServe 72330,1621
Page 10
The ToolDriver package
Your ToolDriver package consists of a set of disks, a ToolDriver User's
Guide (this manual), FileXref User's Guide, and a NameChanger User's Guide.
The FileXref and NameChanger user guide documents will only be needed if you
want to run these tools outside of the ToolDriver environment (directly from
DOS).
The disks contain all the programs and files you need to cross reference
your disk files and make changes to your naming conventions.
SECTION 2: Installing ToolDriver
──────────────────────────────────────
Users who downloaded ToolDriver from a BBS see README.DOC for installation
instructions.
The ToolDriver installation procedure will verify that you have enough space
on your hard drive, create directories as needed and transfer files from
the distribution diskette to your hard disk. It will let you print out the
documentation and read pertinent information about ToolDriver. Its actions
are self-explanatory; the following instructions tell you all you need to
know.
To install ToolDriver:
1. Insert the installation disk into drive A. Type the following command,
then press Enter.
A:INSTALL
2. Follow the prompts.
3. At the end of installation, you may want to add this line to your
CONFIG.SYS file: FILES=20
4. Insure that DOS is in the PATH statement in your AUTOEXEC.BAT file.
Running ToolDriver
Once you've installed ToolDriver, and if you're anxious to get up and
running, change to the TOOLDRIV directory (if you didn't pick another name
yourself), type TD and press Enter. Otherwise, continue reading this
documentation to see what you can do with ToolDriver.
Page 11
SECTION 3: ToolDriver Basics
──────────────────────────────────────
The ToolDriver platform for organizing files and names was developed using
Borland's Turbo Vision for C++. It has everything you need to setup, run,
view and print output from cross referencing as well as name-changing
functions.
It provides:
■ multiple resizable windows that can be moved
■ mouse support and dialog boxes
■ cut, paste, and copy commands using a clipboard
■ a small, fast editor for preparing and revising input files
■ online Help
■ quick access to other programs and back again
This section explains the following topics:
■ starting and exiting ToolDriver
■ working with windows
■ using dialog boxes to communicate with ToolDriver
Starting ToolDriver
To start ToolDriver, go to the ToolDriver directory ( C:\TOOLDRIV by default
), type TD and press Enter at the DOS prompt.
Exiting ToolDriver
There are two ways to leave ToolDriver:
■ Choose File│Quit to leave ToolDriver completely; you have to type TD
again to reenter it. You'll be prompted to save your work before exiting,
if you haven't already done so.
■ Choose File│DOS Shell to shell out from ToolDriver to enter commands at
the DOS command line. When you're ready to return to ToolDriver, type
EXIT at the command line and press Enter. You will be able to resume work
just as you left it.
The User Interface
ToolDriver has three visible objects: a menu bar at the top of the screen, a
window area in the middle, and a status line at the bottom of the screen.
If you are already familiar with the Borland IDE interface, then you may
want to skip the rest of this section and read the sections on cross
referencing (see FileXref, page 28) and changing names (see NameChanger,
page 34).
Page 12
The menu bar and menus
The menu bar is your primary access to all the commands on the menu. It is
always visible except when you're viewing your program's output or
transferring to another program.
Here is how you choose menu commands using the keyboard:
1. Press F10. This makes the menu bar active. The next thing you type will
relate to items on the menu bar.
2. Use the left and right arrow keys to select the menu you want to
display. Then press Enter.
As a shortcut for this step, you can just press the highlighted letter
of the menu title. For example, when the menu bar is active press N to
move to and display the NameChanger menu.
A third way of doing this step is to hold down the Alt key and then
press a highlighted letter from the menu bar titles (such as Alt+N) to
display the menu you want.
3. Use the up and down arrows now to select a command from the menu
displayed.
At this point ToolDriver either carries out the command or displays a dialog
box.
There are two ways to choose menu commands with a mouse:
1. Click the desired menu title to display the menu and click the desired
command from the menu.
2. Or, drag straight from the menu title down to the menu command. Release
the mouse button on the command you want. (If you change your mind,
just drag off the menu and no command will be chosen.)
Some menus and menu commands are unavailable when it would make no sense to
choose them.
Following are lists of keyboard shortcuts (or hot keys) for accessing the
menu bar, choosing menu commands, and working with dialog boxes.
Page 13
Table 1: General hot keys
Hot Key Menu command Function
──────────────────────────────────────
F1 Help Displays a context-sensitive help screen
F2 File│View Brings up a dialog box for viewing a file
F4 Window│Close Closes the active window
F5 Window│Zoom Toggles the active window's size
F10 (none) Takes you to the menu bar
──────────────────────────────────────
Table 2: Menu hot keys
Hot Key Menu Function
──────────────────────────────────────
Alt+Spacebar ≡ Takes you to the ≡(Product Info) menu
Alt+E Edit Takes you to the Edit menu
Alt+F File Takes you to the File menu
Alt+H Help Takes you to the Help menu
Alt+N NameChanger Takes you to the NameChanger menu
Alt+S Search Takes you to the Search menu
Alt+W Window Takes you to the Window menu
Alt+X FileXref Takes you to the FileXref menu
───────────────────────────────────────
Table 3: Editing hot keys
Hot Key Command Function
───────────────────────── ──────────────
Ctrl+Ins Edit│Copy Copies selected text to the clipboard
Shift+Del Edit│Cut Places selected text in the clipboard,
deletes selected text
Shift+Ins Edit│Paste Pastes text from the clipboard into the
active window
Ctrl+Del Edit│Clear Removes selected text from a window, but
doesn't put it in the clipboard
Ctrl+L Search│Search Again Repeats last find or replace
F3 File│Save Saves the file in the active edit window
──────────────────────────────────────
Page 14
Table 4: Window management hot keys
Hot Key Menu command Function
──────────────────────── ──────────────
Alt+n (none) Displays window n, where n is the number
of the window you want to see
F4 Window│Close Closes the active window
F5 Window│Zoom Toggles the size of the active window
Ctrl+F5 Window│Size/Move Changes the size or position of the active
window
F6 Window│Next Makes the next window the active one
Shift+F6 Window│Previous Makes the prior window the active one
──────────────────────────────────────
Table 5: Online help hot keys
Hot Key Function
──────────────────────────────────────
F1 Opens a context-sensitive help screen
Alt+F1 Displays the previous help screen
──────────────────────────────────────
Working with windows
Most of what you see and do in ToolDriver happens in a window. A window is a
screen area that you can open, close, move, resize, zoom, tile, and overlap.
You can have many windows open in ToolDriver, but only one window can be
active at any time. Any menu command you choose or text you type generally
applies only to the active window.
You can easily spot the active window - it's the one with the double-lined
border around it. The active window always has a close box, a zoom box, and
scroll bars. If your windows are overlapping, the active window is always on
top of all the others.
There are several types of windows, but most of them have these things in
common:
■ a title bar
■ a close box
■ scroll bars
■ a zoom box
■ a window number (1 to 9)
An edit window also displays the current line and column numbers in the
lower left corner. If you've modified your file, an asterisk (*) appears to
the left of the column and line numbers.
Page 15
The following figure shows a typical window:
Figure 1: A typical window
┌────────────────────────┐
│ The title bar contains │
│ the name of the window │
└───────────┬────────────┘
│
┌───────────────┐ │ ┌───────────────────────┐
│ Click the │ │ │ Click on the zoom box │
│ close box to │ │ │ to either enlarge or │
│ quickly close │ │ │ shrink the window │
│ the window │ │ └─────────────┬─────────┘
└──────┬────────┘ │ │
│ │ │
┌─ ╔══[■}════════════ Window Title ════════ 4 ═[]══╗ ─┐
│ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║ │
│ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
│ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│░░░░░░░▓ │
│ ║░░░░░░░░░░░░░░░░░░░┌────────────────────┴────┐░░▓ │
│ ║░░░░░░░░░░░░░░░░░░░│ The first 9 open │░░▓ │
│ ║░░░░░░░░░░░░░░░░░░░│ windows have a window │░░■ │
│ ║░░░░░░░░░░░░░░░░░░░│ number. Use Alt and n │░░▓ │
│ ║░░░░░░░░░░░░░░░░░░░│ to make window n active │░░▓ │
│ ║░░░░░░░░░░░░░░░░░░░└─────────────────────────┘░░▓ │
│ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓ │
│ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓ │
│ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓ │
│ ║░░░░░░░░┌───────────────────────────┐░░░░░░░░░░░▓ │
│ ║░░░░░░░░│ Use a mouse to scroll the ├─────────░▓ │
│ ║░░░░░░░░│ contents of the window │░░░░░░░░░░░▓ │
│ ║░░░░░░░░└─────────┬─────────────────┘░░░░░░░░░░░▓ │
│ ║░░░░░░░░░░░░░░░░░░│░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓ │
│ ║░░░░░░░░░░░░░░░░░░│░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓ │
│ ║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
│ ╚═▓▓▓▓▓▓▓▓▓■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓─┘ │
│ │
│ │ ┌────────────────────────────┐ │ │
└───┴────────────│ Drag any corner to make │──────┴───┘
│ windows larger or smaller. │
└────────────────────────────┘
The close box of a window is the box in the upper left corner. Click this
box to quickly close the window. (Or choose Window│Close.) The help windows
are considered temporary. You can close them by pressing Esc.
Page 16
The title bar, the topmost horizontal bar of a window, contains the name of
the window and the window number. Double-clicking the title bar zooms the
window. You can also drag the title bar to move the window around.
The zoom box of a window appears in the upper right corner. If the icon in
that corner is an up arrow(), you can click the arrow to enlarge the window
to the largest possible size. If the icon is a double-headed arrow(), the
window is already at its maximum size. In that case, clicking it returns the
window to its previous size. To zoom a window from the keyboard, choose
Window│Zoom.
The first nine windows you open in ToolDriver have a window number in the
upper right border. You can make a window active (and bring it to the top)
by pressing Alt and the window number. For example if the FileXref output
report window is window number 4 and it's behind other windows, then Alt+4
brings it to the top so it's fully visible.
Scroll bars are horizontal or vertical bars that look like this:
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
Scroll bars show you where you are in relation to what you're viewing. You
use these bars with a mouse to scroll the contents of the window. Click the
arrow at either end to scroll one line at a time. (Keep the mouse button
pressed to scroll continuously.) You can click the shaded area to either
side of the scroll box to scroll a page at a time.
Finally, you can drag the scroll box to any spot on the bar to quickly move
to a spot in the window relative to the position of the scroll box.
You can drag the bottom right corner to make a window larger or smaller. To
resize from the keyboard, choose Size/Move from the Window menu. Use the
arrow keys alone to move or hold down the shift key while using the arrow
keys to resize the window. Press enter when finished to get out of the
sizing/moving mode.
Table 6 is a quick reference for using windows in ToolDriver. Note that you
don't need a mouse to perform these actions - a keyboard works fine too.
Page 17
Table 6: How to use windows
To do this Use one of these techniques
───────────────────────────────────────────────────────────────────────────
Open a file viewer Choose File│View to open a file and scroll it in a
window.
Open other windows Choose the desired window from the Window menu.
Close a window Choose Close from the Window menu or click the close
box of the window or Press F4.
Activate a window Click anywhere in the window, or
Press Alt plus the window number (1 to 9), or
Choose Window│Next (F6 is the hot key) to step
through the windows in the order you created them,
or
Choose Window│Previous (Shift+F6 is the hot key)
to step through the windows in the reverse of the
order you created them.
Move an active window Drag its title bar. Or choose Window│Size/Move
and use the arrow keys to place the window where you
want it, then press Enter.
Resize the active Drag the bottom right corner. Or choose
window Window│Size/Move and press Shift while you use the
arrow keys to resize the window, then press Enter.
Zoom the active Click the zoom box in the upper right corner of the
window window, or
Double-click the window's title bar, or
Choose Window│Zoom (F5 is the hot key)
───────────────────────────────────────────────────────────────────────────
The status line
The status line appears at the bottom of the screen to
■ remind you of basic keystrokes and shortcuts (or hot keys) applicable in
the active window.
■ let you use the mouse to click on a command to perform the action instead
of choosing the action from the menu or pressing the shortcut keystroke.
Page 18
Here is what the status line looks like:
┌───────────┬───────────────────────────────────────────┬──┐
│ToolDriver │ F1 Help F2 View F4 Close F5 Zoom F10 Menu │Id│
└───────────┴───────────────────────────────────────────┴──┘
Where Id is the serial number of your registered software.
Dialog boxes
A menu command with an ellipsis (...) after it leads to a dialog box. Dialog
boxes offer a convenient way to view and set multiple options. When you're
making settings in dialog boxes, you work with five basic types of onscreen
controls: action buttons, radio buttons, check boxes, input boxes, and list
boxes.
Action buttons
│ OK │
│ Cancel │
Above are two action buttons, OK and Cancel. If you choose OK, the choices
in the dialog box are accepted; if you choose Cancel, nothing changes, no
action takes place, and the dialog box is put away. Choose Help to open a
Help window about this dialog box. Esc is always a keyboard shortcut for
Cancel (even if no Cancel button appears).
If you're using a mouse, click the dialog-box button you want. When you're
using the keyboard, press Alt and the highlighted letter of a command to
activate it. For example Alt+C selects the Cancel button because the C in
Cancel is highlighted. Press Tab or Shift+Tab to move forward or back from
one item to another in a dialog box. Each element is highlighted when it
becomes active.
In this dialog box, OK is the default button, which means you need only
press Enter to choose the button. (On monochrome systems, arrows indicate
the default; on color monitors default buttons are highlighted.) Be aware
that tabbing to a button makes that button the default.
Page 19
Radio Buttons and check boxes
┌───────────────────────────────────┐
│ Radio Buttons Check Boxes │
│ ( ) Option 1 ( ) Option A │
│ ( ) Option 2 (X) Option B │
│ (■) Option 3 ( ) Option C │
│ (X) Option D │
└───────────────────────────────────┘
Radio buttons are like car-radio buttons. They come in groups, and only one
radio button in the group can be on at any one time. To choose a radio
button, click it or its text. From the keyboard, select Alt and the
highlighted letter, or press Tab until the group is highlighted, and then
use the arrow keys to choose a particular radio button. Press Tab or
Shift+Tab again to leave the group with the new radio button chosen. Check
boxes differ from radio buttons in that you can have any number of check
boxes checked at any time. When you select a check box, an X appears in it
to show you it's on. An empty box indicates it's off. To change the status
of a check box, click it or its text, press Tab until the check box is
highlighted and then press Spacebar, or select Alt plus the highlighted
letter.
If several check boxes apply to a topic, they appear as a group. In that
case, tabbing moves to the group. Once the group is selected, use the arrow
keys to select the item you want, and then press Spacebar to check or
uncheck it. On monochrome monitors, the active check box or group of check
boxes will have a chevron symbol (») to the left and right. When you press
Tab, the chevrons move to the next group of check boxes or radio buttons.
Input boxes and list boxes
Input boxes let you type in text. Most basic text-editing keys work in the
text box (for example, arrow keys, Home, End, and Ins). If you continue to
type once you reach the end of the box, the contents automatically scroll.
If there's more text than shows in the box, arrowheads appear at the end (
and ). You can click the arrowheads to scroll or drag the text. If you need
to enter control characters (such as ^L or ^M) in the input box, then prefix
the character with a ^P. So, for example, to enter ^M into the input box,
hold down the Ctrl key and press PM. (This capability is useful for search
strings.)
If an input box has a down arrow () icon to its right, there is an
associated history list. Click the icon to display the list. You'll find
text you typed the last few times you used the input box. Press Enter to
choose an item from this list. The Find box, for example, has such a history
list, which keeps track of the text you searched for previously. Try
choosing a previous search string. You can also edit an entry in the history
list. Press Esc to exit from the history list without making a selection
or Enter to continue.
Page 20
A final component of many dialog boxes is a list box, which lets you scroll
through and select from variable-length lists (often file names) without
leaving a dialog box.
You make a list box active by clicking it or by choosing the highlighted
letter of the list title (or press Tab until it's highlighted). Once a list
box is displayed, you can use the scroll box to move through the list or
press the up and down arrows from the keyboard.
SECTION 4: Menus and options reference
──────────────────────────────────────
This section provides a reference to each ToolDriver menu option. It's
arranged in the order that the menus appear on the screen. For information
on starting and exiting ToolDriver, and general information on how the user
interface works, see Section 1.
Next to some of the menu option descriptions in this reference you'll see
keyboard shortcuts, or hot keys.
≡ (System) menu Alt+Spacebar
The ≡ menu appears on the far left of the menu bar. Alt+Spacebar is the
fastest way to get there. When you pull down the menu (by using the down
arrow) you see two commands, Register and Product Information.
Register
Choose ≡│Register to print information about the advantages of registering
and to print a ToolDriver Registration form. A file print dialog will be
presented, with the file REGISTER.DOC selected. Just press enter to print
the file.
Product Information
The ≡│Product Information menu command displays the version of ToolDriver
you are running. The same information displays when you initially bring up
ToolDriver. Put this information away by pressing enter.
File menu Alt+F
The file menu lets you open and view files in a file viewer window. It also
lets you print files, change the working directory, shell to DOS and exit
the ToolDriver environment.
Page 21
View F2
The File│View command displays a file-selection dialog box for you to select
a text file to open in a file viewer window. Here is what the box looks
like:
Figure 2: View a File dialog box
╔══[■}═════════════════ View a File ═══════════════════╗
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░ Name░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░ *.* ░░░░░ Open ░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░ Files ░░░░░░░░░░░░░░░║
║░░░ CRE8FSL.EXE │ FILEXREF.WSL ░░░░ Cancel ░░║
║░░░ FILELIST.EXE │ FILEXREF.XRF ░░░░░░░░░░░░░░░║
║░░░ FILEXREF.BAK │ HISTORY.DOC ░░░░░░░░░░░░░░░║
║░░░ FILEXREF.EXE │ NAMEC.EXE ░░░░░░░░░░░░░░░║
║░░░ FILEXREF.FEI │ NAMEC.FSL ░░░░░░░░░░░░░░░║
║░░░ FILEXREF.FSL │ NAMEC.MSG ░░░░░░░░░░░░░░░║
║░░░ FILEXREF.MSG │ NAMEC.SRL ░░░░░░░░░░░░░░░║
║░░░»FILEXREF.RPT« │ \WORK ░░░░░░░░░░░░░░░║
║░░░ ■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░C:\TOOLDRIV\*.* ║
║░░░FILEXREF.RPT 133153 Sep 01,1992 09:15a ║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
╚══════════════════════════════════════════════════════╝
The dialog box contains an input box, a file list, buttons labeled Open and
Cancel, and an information panel that describes the selected file. Now you
can do any of these actions:
■ Type in a full file name and choose Open. Open loads the file into a
file viewer window.
■ Type in a file name with wildcards, which filters the file list to match
your specifications.
■ Press to choose a file specification from a history list of file
specifications you've entered earlier.
■ View the contents of different directories by selecting a directory name
in the file list.
The input box lets you enter a file name explicitly or enter a file name
with standard DOS wildcards (* and ?) to filter the names appearing in the
history list box. If you enter the entire name and press enter, ToolDriver
opens it for viewing.
If you press when the cursor is blinking in the input box, a history list
Page 22
drops down below the box. This list displays the last 15 file names or
file name masks you've entered. Choose a name from the list by
double-clicking it or selecting it with the arrow keys and pressing Enter.
Once you've typed in or selected the file you want, choose the Open button
(choose Cancel if you change your mind). You can also just press Enter once
the file is selected, or you can double-click the file name in the file
list.
The file viewer will view text files up to about 40K in length.
Using the file list box
The File list box displays all file names in the current directory that
match the specifications in the input box, displays the parent directory,
and displays all subdirectories. Click the list box or press Tab until the
list box name is highlighted. You can now press or to select a filename
and then press Enter to open it. You can also double-click any file name in
the box to open it. You might have to scroll the box to see all the names.
If you have more than one panel of names, you can also use the left and
right arrows.
The file information panel at the bottom of the View a File dialog box
displays path name, file name, date, time and size of the file you've
selected in the list box. As you scroll through the list box, the panel is
updated for each file.
Print
The File│Print command displays a file-selection dialog box for you to
select a text file to be printed. It looks and functions like the File│View
command except that the output will be routed to your printer instead of a
file viewer.
Change Dir
The File│Change Dir command lets you specify a drive and a directory to make
current. The current directory is the one ToolDriver uses for viewing and
printing files.
Here is what the Change Directory dialog box looks like:
Page 23
Figure 3: Change Directory dialog box
╔══[■}═══════════════ Change Directory ════════════════╗
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░ Directory Name ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░ C:\TOOLDRIV ░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░ Directory Tree ░░░░░░░░░░░░░░░║
║░░░ Drives ░░░░ OK ░░║
║░░░ C:\ ▓ ░░░░░░░░░░░░░░░║
║░░░ └─TOOLDRIV ▓ ░░░░ Chdir ░░║
║░░░ └─WORK ▓ ░░░░░░░░░░░░░░░║
║░░░ ■ ░░░░ Revert ░░║
║░░░ ▓ ░░░░░░░░░░░░░░░║
║░░░ ▓ ░░░░░░░░░░░░░░░║
║░░░ ░░░░░░░░░░░░░░░║
║░░░ ░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
╚══════════════════════════════════════════════════════╝
There are two ways to change directories:
■ Type in the path of the new directory in the input box and press Enter
■ Choose the directory you want in the directory tree (if you're using the
keyboard, press Enter to make it the current directory), then choose OK
or press Esc.
If you choose the OK button, your changes are made and the dialog box is
closed. If you choose the Chdir button, the Directory Tree list box changes
to the selected directory and displays the subdirectories of the currently
highlighted directory (pressing Enter or double-clicking on that entry
gives you the same result). If you change your mind about the directory
you've picked and you want to go back to the previous one (and you've yet to
exit the dialog box), choose the Revert button.
Running commands under the FileXref and NameChanger menus automatically
changes the directory to ToolDriver's installation directory where its
program and help files reside.
DOS Shell
The File│DOS Shell command lets you temporarily exit ToolDriver to enter a
DOS command or program. To return to ToolDriver, type EXIT and press Enter.
Don't install any TSR programs (like SideKick) or print a file with the DOS
print command while you've shelled to DOS, because memory may be
misallocated.
Page 24
Quit Alt+Q
The File│Quit command exits ToolDriver and removes it from memory. If you
have made any changes you haven't saved, ToolDriver asks if you want to save
them before exiting.
Edit menu Alt+E
The Edit menu lets you cut, copy, and paste text in edit windows. You can
also open a Clipboard window to view or edit its contents.
ToolDriver does not offer a general purpose editor. An edit window is only
created to support the modification of input files used by the FileXref and
NameChanger utilities. Edit (and Search) menu commands are disabled
otherwise.
A file edit window is presented in four cases:
■ after processing the FileXref│Files dialog (This allows you to modify
the list of files to be cross referenced.)
■ after choosing the FileXref│Words command (This allows you to modify a
list of words to be cross referenced.) (You do not need to list the names
of any files here - they are automatically cross referenced.)
■ after processing the NameChanger│Files dialog (This allows you to
modify the list of files to be name-changed.)
■ after choosing the NameChanger│Names command (This allows you to specify
the names to be changed and what they are to be changed to.) (Names may
be file names; variable names; i.e. any complete symbol)
Before you can use most of the commands on the edit menu, you need to know
about selecting text (because most editor actions apply to selected text).
Selecting text means highlighting it. You can select text either with
keyboard commands or with a mouse; the principle is the same even though the
actions are different.
From the keyboard
■ Press Shift while pressing any key that moves the cursor.
Using a mouse
■ To select text with a mouse, drag the mouse pointer over the desired text
If you need to continue the selection past a window's edge, just drag off
the side and the window automatically scrolls.
■ To select a single word, double-click it.
Page 25
■ To extend or reduce the selection, Shift-click anywhere in the document
(that is, hold Shift and click). Once you've selected text, the Cut and
Copy commands in the Edit menu become available.
The Clipboard is the magic behind cutting and pasting. It's a special window
that holds text you cut or copied, so you can paste it elsewhere. The
Clipboard works in close concert with the commands in the Edit menu.
Here's an explanation of each command in the Edit menu.
Cut Shift+Del
The Edit│Cut command removes the selected text from your document and places
the text in the Clipboard. You can then paste that text into any other
document (or somewhere else in the same document) by choosing Paste. The
text remains selected in the Clipboard so that you can paste the same text
many times.
Copy Ctrl+Ins
The Edit│Copy command leaves the selected text intact but places an exact
copy of it in the Clipboard. You can then paste that text into any other
document by choosing Paste.
Paste Shift+Ins
The Edit│Paste command inserts from the Clipboard into the current edit
window at the cursor position. The text that is pasted is the currently
marked block in the Clipboard window.
Show Clipboard
The Edit│Show Clipboard command opens the Clipboard window, which stores the
text you cut and copy from other windows. The text that's currently selected
(highlighted) is the text ToolDriver uses when you choose Paste.
You can think of the Clipboard window as a history list of your cuts and
copies. You can edit the Clipboard so that the text you paste is precisely
the text you want. ToolDriver uses whatever text is selected in the
Clipboard when you choose Paste.
The Clipboard window is just like other edit windows; you can move it,
resize it, and scroll and edit its contents. The only difference you'll find
in the Clipboard window is when you choose to cut or copy text. When you
select text in the Clipboard window and choose Cut or Copy, the selected
text immediately appears at the bottom of the window. (Remember, any text
you cut or copy is appended to the end of the Clipboard and highlighted - so
you can paste it later.
Page 26
Search menu Alt+S
The Search menu lets you search and replace text in edit windows.
Find Ctrl+Q+F
The Search│Find command displays the Find Text dialog box, which lets you
type in the text you want to search for and set options that affect the
search.
Figure 4: The Find Text dialog box
╔══[■}════════════ Find Text ════════════════╗
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░» Text to Find ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░aardvark ░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░ Options ░░░░░░░░░░░░░░░░░░║
║░░░ (X) Case Sensitive ░░░░░░░░░░░░░░░░░░║
║░░░ ( ) Whole words only ░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░» OK «░░ Cancel ░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
╚══════════════════════════════════════════════╝
The Find Text dialog box contains several buttons and check boxes:
┌────────────────────┐ Check the Case Sensitive box if
│ (X) Case sensitive │ you do want ToolDriver to
└────────────────────┘ differentiate uppercase from
lowercase.
┌──────────────────────┐ Check the Whole words Only box if
│ ( ) Whole words only │ you want ToolDriver to search for
└──────────────────────┘ whole words only. (that is, the
string must have punctuation or
space characters on both sides)
Page 27
Replace Ctrl+Q+A
Following is the dialog for replacing text.
Figure 5: The Replace Text dialog box
╔══[■}═════════ Replace Text ════════════════╗
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░» Text to Find ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░aardvark ░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░ New text ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░platypus ░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░ Options ░░░░░░░░░░░░░░░░░░║
║░░░ (X) Case Sensitive ░░░░░░░░░░░░░░░░░░║
║░░░ ( ) Whole words only ░░░░░░░░░░░░░░░░░░║
║░░░ ( ) Prompt on replace ░░░░░░░░░░░░░░░░░░║
║░░░ ( ) Replace all ░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░» OK «░░ Cancel ░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
╚══════════════════════════════════════════════╝
The Replace Text dialog box contains several radio buttons and check boxes -
many of which are identical to the Find Text dialog box, just discussed. An
additional checkbox, Prompt on Replace, controls whether you want to be
prompted for each change.
Enter the search string and the replacement string in the input boxes and
choose OK to begin the search or Cancel to not do it. If you want to enter a
string you used previously, press to show a history list to choose from.
If ToolDriver finds the specified text and Prompt on Replace is on, it asks
you if you want to make the replacement. If you choose OK, it will find and
replace the first instance of the search item.
Search Again Ctrl+L
The Search│Search Again command repeats the last Find or Replace command.
All settings you made in the last dialog box used (Find or Replace) remain
in effect when you choose Search Again.
Page 28
FileXref Alt+X
The FileXref menu item is the place to go when you want to see how your text
files relate to one another. It is also where you can find the global usage
of words (data names, function names, language verbs, etc.) throughout your
source and documentation files. It may be used with any text file.
The menu item is named FileXref since it uses the ConVal FILEXREF.EXE
program to do the cross referencing. This program may also be used
independently of the ToolDriver environment (see the separate FileXref
User's Guide in text file FILXRF.DOC).
There are four supporting options on this menu:
■ Files to cross reference
■ Words to cross reference
■ Start cross referencing
■ View the output log
Files to cross reference
Here you identify the files you want to cross reference. You do this by
creating a list of those file names. The dialog box you use looks like this:
Figure 6: Files to cross reference
╔══[■}══ Files to be cross referenced ══════════╗
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░[X] Generate a file list for me ░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░ using the directory tree starting with: ░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░»C:\PROJECT1 ░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░» OK «░░ Cancel ░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
╚════════════════════════════════════════════════╝
If you check the check box and enter a directory (as above) or drive (like
C:), then a list will be prepared for you. It will be written to file
FILEXREF.FSL, the File Specification List. The list will include files in
the directory entered and in its subdirectories and their subdirectories
(the directory tree).
In any case you will be presented with an edit window for this file. The
contents of the file edit window will be what was just generated if you
checked the check box, or as most recently edited by you, or it will be as
delivered on the installation disk.
Page 29
Following are representative entries in the file specification list:
────────────────────────────────────
C:\PROJECT1\SOURCE\SAMPLE01.C
C:\PROJECT1\SOURCE\SAMPLE02.C
C:\PROJECT1\INCLUDE\MYSAMP.H
D:\PROJECT1\DOCS\OVERVIEW.DOC
────────────────────────────────────
Start each line in column one and press Enter for each line.
Press F3 to save your changes or F4 to close the window (this will cause a
prompt to save).
NOTE: The editor will handle files to about 64K. This will handle hundreds
of file names. If your application is larger than this we assume you have an
editor! Drop out of ToolDriver, edit the list with that editor, and return
to ToolDriver to do the cross referencing.
Words to cross reference
ToolDriver, as installed, provides a starter file of words to cross
reference. This file is named FILEXREF.WSL (Word Specification List). When
you first select this option you will see the starter list. It contains
entries like
─────────────────────────
I re*
X return
X break
─────────────────────────
The I/X means to Include or eXclude the word or word prefix. The entry "I
re*" asks that words starting with the characters re be included in the word
usage report. The entry "X return" says to exclude the word "return". (The
starter list excludes the C keywords. The last entry shown is not required
(break does not start with "re"). However, it is not considered an error.
This allows you to keep a list of words to be excluded (like language
keywords) regardless of the words you are currently including.
Start cross referencing
Once you've set up the list of files to be examined and (optionally) the
words to search for, select this menu item to initiate cross referencing.
Page 30
This is what the associated dialog looks like:
Figure 7: The Cross reference files dialog
╔══[■}═════ Cross reference files (and words) ═══════════╗
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║ Type of output ░ Optional output ░░░║
║░ (■) Condensed reports ░░ [ ] Cross reference words ░░░║
║░ ( ) Extended reports ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░ ( ) Export file ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░ » OK « ░░ Cancel ░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
╚════════════════════════════════════════════════════════╝
Three types of output are available. The condensed report format displays
file names only, without the path or file extension. It packs the most
information in the smallest number of pages. The extended report format
displays the full file specification (drive, path, file name and extension).
Export file format provides a means for you to take the cross reference
information and use it with other software (e.g. a database program).
If you click on the optional output of Cross reference words, then the words
you picked for inclusion and exclusion will be used and a Word Usage Report
will be produced. Otherwise the list of words will be ignored.
Use File│Print to print file FILEXREF.RPT, the report file. Note: The
reports require 132 print positions.
When you select condensed reports, the following reports
■ Condensed File Cross Reference Report,
■ Condensed Word Usage Report, and
■ List of Unreferenced Files
will be written to file FILEXREF.RPT.
Choosing extended reports will cause these reports
■ Extended File Cross Reference Report,
■ Extended Word Usage Report, and
■ List of Unreferenced Files
to be written to file FILEXREF.RPT.
Picking export files will create two text data files:
■ cross reference data on file FILEXREF.XRF, and
■ unused file data on file FILEXREF.FEI
Page 31
Condensed Reports
The condensed style of reports identify files by their filename alone,
without the drive, path, or file extension. Figure 8 shows a condensed file
cross reference report (showing less columns to the left and right for
reasons of space in this manual). The center column lists every file
examined, sorted by file name. To the left are the files that reference it
and to the right are those that it references.
Figure 8: Condensed File Cross Reference Report
────────────────────────────────────────────────────────────────────────────
09/19/92 FileXref CONDENSED FILE CROSS REFERENCE REPORT Page 1
LIST OF REFERENCING FILES FILENAME LIST OF REFERENCED FILES
---------------------------- ======== -------------------------------
- FILEXRF -
PACKLIST TOOLDRIV - HISTORY -
- NAMECHNG - README
- PACKLIST - HISTORY README REGISTER
TOOLDRIV
NAMECHNG PACKLIST TOOLDRIV - README -
PACKLIST TOOLDRIV - REGISTER -
PACKLIST - TOOLDRIV - HISTORY README REGISTER
*** END OF REPORT
────────────────────────────────────────────────────────────────────────────
In Figure 9 you see the optional condensed word usage report. This shows
each word (and word prefix) requested, and the files that reference them.
Figure 9: Condensed Word Usage Report
────────────────────────────────────────────────────────────────────────────
09/19/92 05:33:38 FileXref CONDENSED WORD USAGE REPORT Page 1
WORD IS REFERENCED BY FILENAME(S):
------------------------------ -------------------------------------------
However FILEXRF
Hungarian NAMECHNG
I FILEXRF HISTORY NAMECHNG README REGISTER
TOOLDRIV
IBM NAMECHNG TOOLDRIV
IBM-compatible TOOLDRIV
IBMPRO HISTORY
ID NAMECHNG
IDE TOOLDRIV
IMS NAMECHNG
INCLUDE FILEXRF NAMECHNG TOOLDRIV
*** END OF REPORT
────────────────────────────────────────────────────────────────────────────
Page 32
In figure 10 we see a list of files that were referenced by no other files.
So this list will contain top level components (and old obsolete components)
of the application.
Figure 10: List of Unreferenced Files
────────────────────────────────────────────────────────────────────────────
09/19/92 05:33:39 FileXref LIST OF UNREFERENCED FILES Page 1
FILENAME TYPE PATH
-------- --- -------------------------
FILEXRF DOC C:\TOOLDRIV\
NAMECHNG DOC C:\TOOLDRIV\
PACKLIST DOC C:\TOOLDRIV\
*** END OF REPORT
────────────────────────────────────────────────────────────────────────────
Extended Reports
The extended report style identifies files with their full file
specification. If your filenames alone are not unique, then this report
style may be more useful to you.
Figure 11: Extended File Cross Reference Report
────────────────────────────────────────────────────────────────────────────
09/19/92 05:37:40 EXTENDED FILE CROSS REFERENCE REPORT Page 1
FILE SPECIFICATION - REFERS TO: FILE SPECIFICATION - REFERS TO: FILENAME
-------------------------- --------------------------------- --------
- C:\TOOLDRIV\FILEXRF.DOC -
C:\TOOLDRIV\PACKLIST.DOC - C:\TOOLDRIV\HISTORY.DOC -
C:\TOOLDRIV\TOOLDRIV.DOC - -
- C:\TOOLDRIV\NAMECHNG.DOC - README
- C:\TOOLDRIV\PACKLIST.DOC - HISTORY
- - README
- - REGISTER
- - TOOLDRIV
C:\TOOLDRIV\NAMECHNG.DOC - C:\TOOLDRIV\README.DOC -
C:\TOOLDRIV\PACKLIST.DOC - -
C:\TOOLDRIV\TOOLDRIV.DOC - -
C:\TOOLDRIV\PACKLIST.DOC - C:\TOOLDRIV\REGISTER.DOC -
C:\TOOLDRIV\TOOLDRIV.DOC - -
C:\TOOLDRIV\PACKLIST.DOC - C:\TOOLDRIV\TOOLDRIV.DOC - HISTORY
- - README
- - REGISTER
*** END OF REPORT
────────────────────────────────────────────────────────────────────────────
Page 33
Figure 12: Extended Word Usage Report
────────────────────────────────────────────────────────────────────────────
09/19/92 05:33:38 FileXref EXTENDED WORD USAGE REPORT Page 1
WORD IS REFERENCED BY FILENAME(S):
-------------------- ------------------------------------------
However C:\TOOLDRIV\FILEXRF.DOC
Hungarian C:\TOOLDRIV\NAMECHNG.DOC
I C:\TOOLDRIV\FILEXRF.DOC
C:\TOOLDRIV\HISTORY.DOC
C:\TOOLDRIV\NAMECHNG.DOC
C:\TOOLDRIV\README.DOC
C:\TOOLDRIV\REGISTER.DOC
C:\TOOLDRIV\TOOLDRIV.DOC
IBM C:\TOOLDRIV\NAMECHNG.DOC
--------------------- ------------------------------------------
*** END OF REPORT
────────────────────────────────────────────────────────────────────────────
Export files
The quote and comma delimited export files are provided so you can import
them into your software. You can then further process the data and/or
produce custom reports of your own design.
File FILEXREF.XRF is the name of the text file where the cross reference
export data is written. It contains a symbol in the first column. The
second column contains the referencing file's file specification. The last
column has six flags. Their meaning is shown in the table following.
Table 7: Export file flags
────────────────────────────────────────────────────-
123456
─────-
The symbol in the first column is:
1..... a filename.
.1.... a whole word.
..1... a word prefix.
...1.. an expansion of a word prefix.
....1. The symbol was referenced.
.....1 The symbol was marked for inclusion.
────────────────────────────────────────────────────-
Figure 13 shows typical data in the cross reference export data file. The
first row shows that the symbol "HISTORY" was referenced by a file named
PACKLIST.DOC. The flags for this symbol tell that the symbol HISTORY is the
name of a file, that it was referenced (every entry in this file will be so
marked), and that it was marked for inclusion. (All file names are
automatically marked for inclusion by default.
Page 34
Figure 13: Cross reference export data
─────────────────────────────────────────────────────-
"HISTORY","C:\TOOLDRIV\PACKLIST.DOC","100011"
"HISTORY","C:\TOOLDRIV\TOOLDRIV.DOC","100011"
"README","C:\TOOLDRIV\NAMECHNG.DOC","100011"
"README","C:\TOOLDRIV\PACKLIST.DOC","100011"
"README","C:\TOOLDRIV\TOOLDRIV.DOC","100011"
"REGISTER","C:\TOOLDRIV\PACKLIST.DOC","100011"
"REGISTER","C:\TOOLDRIV\TOOLDRIV.DOC","100011"
"TOOLDRIV","C:\TOOLDRIV\PACKLIST.DOC","100011"
"re*","C:\TOOLDRIV\FILEXRF.DOC","001101"
"re*","C:\TOOLDRIV\HISTORY.DOC","001101"
"re*","C:\TOOLDRIV\NAMECHNG.DOC","001101"
"re*","C:\TOOLDRIV\README.DOC","001101"
"re*","C:\TOOLDRIV\REGISTER.DOC","001101"
"re*","C:\TOOLDRIV\TOOLDRIV.DOC","001101"
"reach","C:\TOOLDRIV\TOOLDRIV.DOC","000101"
"read","C:\TOOLDRIV\FILEXRF.DOC","000101"
"read","C:\TOOLDRIV\NAMECHNG.DOC","000101"
─────────────────────────────────────────────────────-
Figure 14 shows the export data for unreferenced files. This data is stored
in text file FILEXREF.FEI (for file end items). None of these files was
referenced by any other file examined.
Figure 14: Unreferenced files export data
───────────────────────────────────────────-
"C:\TOOLDRIV\FILEXRF.DOC","100001"
"C:\TOOLDRIV\NAMECHNG.DOC","100001"
"C:\TOOLDRIV\PACKLIST.DOC","100001"
───────────────────────────────────────────-
View the output log
This command gives you a file viewer window to browse the messages about the
cross referencing. These document the scope of the run, listing the files
and words specified, the options, and record counts. You can use File│Print
to get a hardcopy of this output log to file with the reports. The name of
the log file is FILEXREF.MSG.
NameChanger menu Alt+N
Use the NameChanger menu whenever you want to go back and make your naming
conventions consistent across your application(s). You might decide to do
this after each revision level is complete to keep order. And, now that you
have such a tool, you may want to go back to some older code you're still
maintaining and clean it up, too.
You will also want to use the NameChanger menu when you have a successful
product on one platform and want to port it to another. Download the non-DOS
product to your PC, do the renaming, and recompile on DOS. Or, do renaming,
upload to a non-DOS platform and recompile there. This works very well for
Oracle code where the names may be the ONLY portability issue.
This command invokes a DOS program - NAMEC.EXE. For information on using
this directly from a DOS command line, see the separate NameChanger User's
Guide in the text file NAMECHNG.DOC.
Page 35
Files to process
This is where you identify the files to be processed by NameChanger. The
dialog box you use looks like this:
Figure 15: NameChanger Files dialog
╔══[■}══ Files with names to be changed ════════╗
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░[X] Generate a file list for me ░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░ using the directory: ░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░»C:\PROJECT1 ░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░» OK «░░ Cancel ░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
╚════════════════════════════════════════════════╝
If you check the check box and enter a directory (as above) or drive (like
C:), then a list will be prepared for you. It will be written to file
NAMEC.FSL (File Specification List). The list will include only those files
in the directory entered.
In any case you will be presented with an edit window for this file. So the
content of the file edit window will be what was just generated if you
checked the check box, or it will be as most recently edited by you, or as
delivered on the installation disk.
Typical lines in this file (NAMEC.FSL) look like:
──────────────────────────────────────
V 255 C:\PROJECT1\TST01.CPP
V 255 C:\PROJECT1\TST02.CPP
V 255 C:\PROJECT1\TST03.CPP
F 80 C:\PROJECT2\REPORT01.COB
F 80 C:\PROJECT2\REPORT02.COB
──────────────────────────────────────
Each line defines one file and contains three columns. The first column
defines whether all the lines in the file have to be the same length (F for
fixed length), or variable length (V). The second column is the maximum
length for an output record (or actual in the case of fixed length file
lines). The last column contains the file specification.
The line format code ( F or V) must begin in the first column of the line.
One or more spaces separate the columns. Press Enter after each line.
Press F3 to save your changes or F4 to close the window (this will cause a
prompt to save).
NOTE: The editor will handle files up to about 64K. This will handle
hundreds of file names. If your application is larger than this we trust
that you have an editor! Drop out of ToolDriver, edit the list with that
editor, and return to ToolDriver to change names.
Page 36
Names to be changed
This is where you define the names you want to be changed. A file editor
window will be displayed so you can add one line for each name change. To
change "cat", "Cat", and "CAT" to "Dog", type
I cat Dog
That's all there is to it - The letter "I" tells the program to be
Insensitive to case. Type one or more spaces after the case sensitivity
code, start typing the old word, type one or more spaces, type the new word
exactly as it is to appear, then press Enter.
To change "Alpha" to "Beta" , while leaving "ALPHA" (and "AlPhA") unchanged,
the entry should look like this:
S Alpha Beta
This change will be Sensitive to the case of the old name. It will not alter
the word Alpha unless the case of each letter matches exactly.
The case sensitivity code (I or S) must start in the first column of each
line. When you've entered all the names to be changed, press F3 to save the
file, and then F4 to close the file editor window. It will be saved as
filename NAMEC.SRL (Symbol Rename List).
Start name changing
After you've defined the files and names to be changed, select the "Start
name changing" dialog. It looks like this:
Figure 16: The Change names dialog
╔══[■}═══════════════ Change names ══════════════════════╗
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║ NOTE: Output files will be written to this ░░░░░░░░░░░║
║░ directory: ░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░ C:\TOOLDRIV\WORK ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░[ ] Delete prior output░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░ » OK « ░░ Cancel ░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
╚════════════════════════════════════════════════════════╝
Whenever you do name changing, the output files will be written to
ToolDriver's subdirectory named WORK. This is the WORK directory's only
purpose. Your files will never be rewritten in place! If you are rerunning a
name changing task, no work will be performed if any output file already
Page 37
exists on the ToolDriver WORK subdirectory. To delete ALL files in the
ToolDriver WORK directory, check the checkbox. As a final precaution, you
will be asked to confirm the deletion, when the process starts. This is a
reminder for you to move prior output to a permanent home in another
directory before renaming other projects. When the changing of names is
complete, you will be presented with a file viewer window to browse a log of
the renaming activity. This name of this text file is NAMEC.MSG. This log
will identify those files that were not changed at all (those that contained
none of the names being changed). It also identifies, by line number, those
cases where lines needed to be split due to excessive length after renaming.
To test NameChanger, have it make an exact copy of some of your files. Do
this by setting the symbol rename list up with one line containing a word
that doesn't exist in your files, say
S aAbBcC AABBCC
Start NameChanger, then use the DOS COMP command to do a character-by-
character compare.
NOTE: Trailing blanks in lines are not copied so it's possible for the
messages to indicate that no words were changed, and still have file
sizes be different.
View the output files
Select this option to inspect the results of your name changing. The
following dialog lets you select a file on the ToolDriver working directory
(where NameChanger places its output).
Figure 17: View the name-changed files dialog box
╔══[■}═════════════════ View a File ═══════════════════╗
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░ Name░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░ *.* ░░░░░ Open ░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░ Files ░░░░░░░░░░░░░░░║
║░░░ FILEXREF.RPT │ TST01.C ░░░░ Cancel ░░║
║░░░ FILEXREF.DOC │ TST02.CPP ░░░░░░░░░░░░░░░║
║░░░ HISTORY.DOC │ TST03.H ░░░░░░░░░░░░░░░║
║░░░ NAMECHNG.DOC │ TST04.PAS ░░░░░░░░░░░░░░░║
║░░░ PACKLIST.DOC │ ..\ ░░░░░░░░░░░░░░░║
║░░░ REGISTER.DOC │ ░░░░░░░░░░░░░░░║
║░░░ TOOLDRIV.DOC │ ░░░░░░░░░░░░░░░║
║░░░ ■▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ░░░░░░░░░░░░░░░║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
║░░░C:\TOOLDRIV\WORK\*.* ║
║░░░FILEXREF.RPT 88722 Sep 18,1992 08:25a ║
║░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░║
╚══════════════════════════════════════════════════════╝
Page 38
See the "View a file" dialog description on page 21 for a review of using
this dialog.
Window menu Alt+W
The Window menu contains window-management commands. Most of the windows you
open from this menu have all the standard window elements like scroll bars,
a close box, and zoom boxes. Refer to page 15 for information on these
elements and how to use them.
Size/Move Ctrl+F5
Choose Window│Size/Move to change the size or position of the active window.
When you choose this command, the active window moves in response to the
arrow keys. When the window is where you want, press Enter. You can also
move a window by dragging its title bar.
If you press shift while you use the arrow keys, you can change the size of
the window. When it's the size you want, press enter. If a window has a
resize corner, you can drag that corner or any other corner to resize it.
Zoom F5
Choose Window│Zoom to resize the active window to the maximum size. If the
window is already zoomed, you can choose this command again to restore it to
its previous size. You can also double-click anywhere on the top line
(except where an icon appears) of a window to zoom or unzoom it.
Tile
Choose Window│Tile to arrange all your open windows like tiles on the
screen.
Cascade
Choose Window│Cascade to stack all open windows so the top of each (with its
window number) shows.
Next F6
Choose Window│Next to make the next window active and visible.
Previous Shift+F6
Choose Window│Previous to make the prior window active and visible.
Close F4
To close the current window, press F4.
Page 39
Help menu Alt+H
The help menu gives you access to online help in a special window. There is
help information on virtually all aspects of the ToolDriver environment. To
open a Help window, do one of these actions:
■ Press F1 at any time (including from any dialog box or when any menu
command is selected).
■ Click Help on the status line.
To close the Help window, press Esc, click the close box, or choose
Window│Close.
Help screens often contain keywords (highlighted text) that you can choose
to get more information. Press Tab to move to any keyword; press Enter to
get more detailed help. (As an alternative, move the cursor to the
highlighted keyword and press Enter.) With a mouse, you can double-click any
keyword to open the Help text for that item.
When you're in a detailed help screen (you got there from another help
screen by selecting a keyword) and you want to go back to the previous help,
press Alt+F1. By doing this repeatedly you can back-track to the original
help screen where you selected the first keyword.
Contents
The Help│Contents command opens the Help window with the main table of
contents displayed. From this window, you can branch to other parts of
the help system.
Index
The Help│Index command displays a full list of Help keywords (the special
highlighted text in Help screens that let you quickly move to a related
screen). These are arranged in alphabetical order.
Double-click or Tab to the item you want and press Enter, or Tab to the
"next page" keyword and press Enter to see the next page of keywords. Hold
down Shift and press Tab to move the cursor to a prior entry on the same
page.
Use Alt+F1 to get back to the previous help screen.
Page 40
INDEX
──────────────────────────────────────
File
export, file cross reference . . . . . . . . . . . . . . . . . . . 33
export, selecting. . . . . . . . . . . . . . . . . . . . . . . . . 30
export, unreferenced files . . . . . . . . . . . . . . . . . . . . 34
list, for cross referencing. . . . . . . . . . . . . . . . . . . . 28
list, for name changing. . . . . . . . . . . . . . . . . . . . . . 35
FILEXREF.EXE
the cross reference tool . . . . . . . . . . . . . . . . . . . . . 28
FILEXREF.FEI
the unreferenced files export file . . . . . . . . . . . . . . . . 34
FILEXREF.FSL
the file specification list for FileXref . . . . . . . . . . . . . 28
FILEXREF.MSG
the cross reference activity log . . . . . . . . . . . . . . . . . 34
FILEXREF.RPT
the cross reference report file. . . . . . . . . . . . . . . . . . 30
FILEXREF.WSL
file of words to be cross referenced . . . . . . . . . . . . . . . 29
FILEXREF.XRF
the cross reference export file. . . . . . . . . . . . . . . . . . 33
Hot keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Log
of cross referencing . . . . . . . . . . . . . . . . . . . . . . . 34
of name changing activity. . . . . . . . . . . . . . . . . . . . . 37
NAMEC.EXE
the name-changing tool . . . . . . . . . . . . . . . . . . . . . . 34
NAMEC.FSL
file of file names to be name-changed. . . . . . . . . . . . . . . 35
NAMEC.MSG
file containing a log of the renaming process . . . . . . . . . . 37
Page 41
NAMEC.SRL
file of symbol renaming rules . . . . . . . . . . . . . . . . . . 36
report
condensed file cross reference, sample. . . . . . . . . . . . . . 31
condensed word usage, sample. . . . . . . . . . . . . . . . . . . 31
creating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
extended file cross reference, sample. . . . . . . . . . . . . . . 32
extended word usage, sample. . . . . . . . . . . . . . . . . . . . 33
list of unreferenced files, sample . . . . . . . . . . . . . . . . 32
printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
selecting the type of. . . . . . . . . . . . . . . . . . . . . . . 30
───────────────────────────────────────
End of User Guide for ToolDriver
───────────────────────────────────────